home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 16 / CU Amiga Magazine's Super CD-ROM 16 (1997-10-16)(EMAP Images)(GB)[!][issue 1997-11].iso / CUCD / Graphics / Ghostscript / source / igc.c < prev    next >
C/C++ Source or Header  |  1997-04-24  |  35KB  |  1,253 lines
  1. /* Copyright (C) 1993, 1996, 1997 Aladdin Enterprises.  All rights reserved.
  2.   
  3.   This file is part of Aladdin Ghostscript.
  4.   
  5.   Aladdin Ghostscript is distributed with NO WARRANTY OF ANY KIND.  No author
  6.   or distributor accepts any responsibility for the consequences of using it,
  7.   or for whether it serves any particular purpose or works at all, unless he
  8.   or she says so in writing.  Refer to the Aladdin Ghostscript Free Public
  9.   License (the "License") for full details.
  10.   
  11.   Every copy of Aladdin Ghostscript must include a copy of the License,
  12.   normally in a plain ASCII text file named PUBLIC.  The License grants you
  13.   the right to copy, modify and redistribute Aladdin Ghostscript, but only
  14.   under certain conditions described in the License.  Among other things, the
  15.   License requires that the copyright notice and this notice be preserved on
  16.   all copies.
  17. */
  18.  
  19. /* igc.c */
  20. /* Garbage collector for Ghostscript */
  21. #include "memory_.h"
  22. #include "ghost.h"
  23. #include "errors.h"
  24. #include "gsexit.h"
  25. #include "gsmdebug.h"
  26. #include "gsstruct.h"
  27. #include "gsutil.h"
  28. #include "iastate.h"
  29. #include "isave.h"
  30. #include "isstate.h"
  31. #include "idict.h"
  32. #include "ipacked.h"
  33. #include "istruct.h"
  34. #include "igc.h"
  35. #include "igcstr.h"
  36. #include "inamedef.h"
  37. #include "opdef.h"            /* for marking oparray names */
  38.  
  39. /* Define whether to force all garbage collections to be global. */
  40. private bool force_global_gc = false;
  41.  
  42. /* Define whether to bypass the collector entirely. */
  43. /*#define NO_COLLECT*/
  44.  
  45. /* Define an entry on the mark stack. */
  46. typedef struct { void *ptr; uint index; bool is_refs; } ms_entry;
  47.  
  48. /* Define (a segment of) the mark stack. */
  49. /* entries[0] has ptr = 0 to indicate the bottom of the stack. */
  50. /* count additional entries follow this structure. */
  51. typedef struct gc_mark_stack_s gc_mark_stack;
  52. struct gc_mark_stack_s {
  53.   gc_mark_stack *prev;
  54.   gc_mark_stack *next;
  55.   uint count;
  56.   bool on_heap;        /* if true, allocated with gs_malloc */
  57.   ms_entry entries[1];
  58. };
  59. /* Define the mark stack sizing parameters. */
  60. #define ms_size_default 100    /* default, allocated on C stack */
  61. /* This should probably be defined as a parameter somewhere.... */
  62. #define ms_size_desired        /* for gs_malloc */\
  63.  ((max_ushort - sizeof(gc_mark_stack)) / sizeof(ms_entry) - 10)
  64. #define ms_size_min 50        /* min size for segment in free block */
  65.  
  66. /* Forward references */
  67. private void gc_init_mark_stack(P2(gc_mark_stack *, uint));
  68. private void gc_objects_clear_marks(P1(chunk_t *));
  69. private void gc_unmark_names(P0());
  70. private int gc_trace(P3(gs_gc_root_t *, gc_state_t *, gc_mark_stack *));
  71. private int gc_rescan_chunk(P3(chunk_t *, gc_state_t *, gc_mark_stack *));
  72. private int gc_trace_chunk(P3(chunk_t *, gc_state_t *, gc_mark_stack *));
  73. private bool gc_trace_finish(P1(gc_state_t *));
  74. private void gc_clear_reloc(P1(chunk_t *));
  75. private void gc_objects_set_reloc(P1(chunk_t *));
  76. private void gc_do_reloc(P3(chunk_t *, gs_ref_memory_t *, gc_state_t *));
  77. private void gc_objects_compact(P2(chunk_t *, gc_state_t *));
  78. private void gc_free_empty_chunks(P1(gs_ref_memory_t *));
  79.  
  80. /* Forward references for pointer types */
  81. private ptr_proc_unmark(ptr_struct_unmark);
  82. private ptr_proc_mark(ptr_struct_mark);
  83. private ptr_proc_unmark(ptr_string_unmark);
  84. private ptr_proc_mark(ptr_string_mark);
  85. /*ptr_proc_unmark(ptr_ref_unmark);*/    /* in igc.h */
  86. /*ptr_proc_mark(ptr_ref_mark);*/    /* in igc.h */
  87. /*ptr_proc_reloc(gs_reloc_struct_ptr, void);*/    /* in gsstruct.h */
  88. /*ptr_proc_reloc(gs_reloc_ref_ptr, ref_packed);*/    /* in istruct.h */
  89.  
  90. /* Pointer type descriptors. */
  91. /* Note that the trace/mark routine has special knowledge of ptr_ref_type */
  92. /* and ptr_struct_type -- it assumes that no other types have embedded */
  93. /* pointers.  Note also that the reloc procedures for string and ref */
  94. /* pointers are never called. */
  95. typedef ptr_proc_reloc((*ptr_proc_reloc_t), void);
  96. const gs_ptr_procs_t ptr_struct_procs =
  97.  { ptr_struct_unmark, ptr_struct_mark, (ptr_proc_reloc_t)gs_reloc_struct_ptr };
  98. const gs_ptr_procs_t ptr_string_procs =
  99.  { ptr_string_unmark, ptr_string_mark, NULL };
  100. const gs_ptr_procs_t ptr_const_string_procs =
  101.  { ptr_string_unmark, ptr_string_mark, NULL };
  102. const gs_ptr_procs_t ptr_ref_procs =
  103.  { ptr_ref_unmark, ptr_ref_mark, NULL };
  104.  
  105. /* ------ Main program ------ */
  106.  
  107. /* Top level of garbage collector. */
  108. #ifdef DEBUG
  109. private void
  110. end_phase(const char _ds *str)
  111. {    if ( gs_debug_c('6') )
  112.       {    dprintf1("[6]---------------- end %s ----------------\n",
  113.              (const char *)str);
  114.         fflush(dstderr);
  115.       }
  116. }
  117. static const char *depth_dots_string = "..........";
  118. private const char *
  119. depth_dots_proc(const ms_entry *sp, const gc_mark_stack *pms)
  120. {    int depth = sp - pms->entries - 1;
  121.     const gc_mark_stack *pss = pms;
  122.  
  123.     while ( (pss = pss->prev) != 0 )
  124.       depth += pss->count - 1;
  125.     return depth_dots_string + (depth >= 10 ? 0 : 10 - depth);
  126. }
  127. #else
  128. #  define end_phase(str) DO_NOTHING
  129. #endif
  130. void
  131. gs_reclaim(vm_spaces *pspaces, bool global)
  132. {    vm_spaces spaces;
  133. #define nspaces (i_vm_max + 1)
  134.     gs_gc_root_t space_roots[nspaces];
  135.     int max_trace;        /* max space to trace */
  136.     int min_collect;    /* min space to collect */
  137.     int ispace;
  138.     gs_ref_memory_t *mem;
  139.     chunk_t *cp;
  140.     gs_gc_root_t *rp;
  141.     gc_state_t state;
  142.     struct _msd {
  143.       gc_mark_stack stack;
  144.       ms_entry body[ms_size_default];
  145.     } ms_default;
  146.     gc_mark_stack *mark_stack = &ms_default.stack;
  147.  
  148.     /* Optionally force global GC for debugging. */
  149.     if ( force_global_gc )
  150.       global = true;
  151.  
  152.     /* Determine which spaces we are collecting. */
  153.     spaces = *pspaces;
  154.     if ( space_global != space_local )
  155.       max_trace = i_vm_local;
  156.     else
  157.       max_trace = i_vm_global;
  158.     min_collect = (global ? 1 : max_trace);
  159.  
  160. #define for_spaces(i, n)\
  161.   for ( i = 1; i <= n; ++i )
  162. #define for_collected_spaces(i)\
  163.   for ( i = min_collect; i <= max_trace; ++i )
  164. #define for_space_mems(i, mem)\
  165.   for ( mem = spaces.indexed[i]; mem != 0; mem = &mem->saved->state )
  166. #define for_mem_chunks(mem, cp)\
  167.   for ( cp = (mem)->cfirst; cp != 0; cp = cp->cnext )
  168. #define for_space_chunks(i, mem, cp)\
  169.   for_space_mems(i, mem) for_mem_chunks(mem, cp)
  170. #define for_chunks(n, mem, cp)\
  171.   for_spaces(ispace, n) for_space_chunks(ispace, mem, cp)
  172. #define for_collected_chunks(mem, cp)\
  173.   for_collected_spaces(ispace) for_space_chunks(ispace, mem, cp)
  174. #define for_roots(n, mem, rp)\
  175.   for_spaces(ispace, n)\
  176.     for ( mem = spaces.indexed[ispace], rp = mem->roots; rp != 0; rp = rp->next )
  177.  
  178.     /* Initialize the state. */
  179.     state.loc.memory = spaces.named.global;    /* any one will do */
  180.     state.loc.cp = 0;
  181.     state.spaces = spaces;
  182.     state.min_collect = min_collect << r_space_shift;
  183.     state.relocating_untraced = false;
  184.  
  185.     /* Register the allocators themselves as roots, */
  186.     /* so we mark and relocate the change and save lists properly. */
  187.  
  188.     for_spaces(ispace, max_trace)
  189.       gs_register_struct_root((gs_memory_t *)spaces.indexed[ispace],
  190.                   &space_roots[ispace],
  191.                   (void **)&spaces.indexed[ispace],
  192.                   "gc_top_level");
  193.  
  194.     end_phase("register space roots");
  195.  
  196. #ifdef DEBUG
  197.  
  198.     /* Pre-validate the state.  This shouldn't be necessary.... */
  199.  
  200.     for_spaces(ispace, max_trace)
  201.       ialloc_validate_memory(spaces.indexed[ispace], &state);
  202.  
  203.     end_phase("pre-validate pointers");
  204.  
  205. #endif
  206.  
  207. #ifdef NO_COLLECT
  208.  
  209.     /* Don't collect at all. */
  210.  
  211.     goto no_collect;
  212.  
  213. #endif
  214.  
  215.     /* Clear marks in spaces to be collected. */
  216.  
  217.     for_collected_spaces(ispace)
  218.       for_space_chunks(ispace, mem, cp)
  219.       {    gc_objects_clear_marks(cp);
  220.         gc_strings_set_marks(cp, false);
  221.       }
  222.  
  223.     end_phase("clear chunk marks");
  224.  
  225.     /* Clear the marks of roots.  We must do this explicitly, */
  226.     /* since some roots are not in any chunk. */
  227.  
  228.     for_roots(max_trace, mem, rp)
  229.       {    void *vptr = *rp->p;
  230.         if_debug_root('6', "[6]unmarking root", rp);
  231.         (*rp->ptype->unmark)(vptr, &state);
  232.       }
  233.  
  234.     end_phase("clear root marks");
  235.  
  236.     if ( global )
  237.       gc_unmark_names();
  238.  
  239.     /* Initialize the (default) mark stack. */
  240.  
  241.     gc_init_mark_stack(&ms_default.stack, ms_size_default);
  242.     ms_default.stack.prev = 0;
  243.     ms_default.stack.on_heap = false;
  244.  
  245.     /* Add all large-enough free blocks to the mark stack. */
  246.     /* Also initialize the rescan pointers. */
  247.  
  248.     { gc_mark_stack *end = mark_stack;
  249.       for_chunks(max_trace, mem, cp)
  250.         {    uint avail = cp->ctop - cp->cbot;
  251.         if ( avail >= sizeof(gc_mark_stack) + sizeof(ms_entry) *
  252.                ms_size_min &&
  253.              !cp->inner_count
  254.            )
  255.           { gc_mark_stack *pms = (gc_mark_stack *)cp->cbot;
  256.             gc_init_mark_stack(pms, (avail - sizeof(gc_mark_stack)) /
  257.                        sizeof(ms_entry));
  258.             end->next = pms;
  259.             pms->prev = end;
  260.             pms->on_heap = false;
  261.             if_debug2('6', "[6]adding free 0x%lx(%u) to mark stack\n",
  262.                   (ulong)pms, pms->count);
  263.           }
  264.         cp->rescan_bot = cp->cend;
  265.         cp->rescan_top = cp->cbase;
  266.         }
  267.     }
  268.  
  269.     /* Mark reachable objects. */
  270.  
  271.     {    int more = 0;
  272.  
  273.         /* Mark from roots. */
  274.  
  275.         for_roots(max_trace, mem, rp)
  276.         {    if_debug_root('6', "[6]marking root", rp);
  277.             more |= gc_trace(rp, &state, mark_stack);
  278.         }
  279.  
  280.         end_phase("mark");
  281.  
  282.         /* If this is a local GC, mark from non-local chunks. */
  283.  
  284.         if ( !global )
  285.           for_chunks(min_collect - 1, mem, cp)
  286.             more |= gc_trace_chunk(cp, &state, mark_stack);
  287.  
  288.         /* Handle mark stack overflow. */
  289.  
  290.         while ( more < 0 )        /* stack overflowed */
  291.           {    more = 0;
  292.             for_chunks(max_trace, mem, cp)
  293.               more |= gc_rescan_chunk(cp, &state, mark_stack);
  294.           }
  295.  
  296.         end_phase("mark overflow");
  297.     }
  298.  
  299.     /* Free the mark stack. */
  300.  
  301.     { gc_mark_stack *pms = mark_stack;
  302.  
  303.       while ( pms->next )
  304.         pms = pms->next;
  305.       while ( pms )
  306.         { gc_mark_stack *prev = pms->prev;
  307.           uint size = sizeof(*pms) + sizeof(ms_entry) * pms->count;
  308.  
  309.           if ( pms->on_heap )
  310.         gs_free(pms, 1, size, "gc mark stack");
  311.           else
  312.         gs_alloc_fill(pms, gs_alloc_fill_free, size);
  313.           pms = prev;
  314.         }
  315.     }
  316.  
  317.     end_phase("free mark stack");
  318.  
  319.     if ( global )
  320.       {
  321.         gc_trace_finish(&state);
  322.         name_trace_finish(&state);
  323.  
  324.         end_phase("finish trace");
  325.       }
  326.  
  327.     /* Clear marks and relocation in spaces that are only being traced. */
  328.     /* We have to clear the marks first, because we want the */
  329.     /* relocation to wind up as o_untraced, not o_unmarked. */
  330.  
  331.     for_chunks(min_collect - 1, mem, cp)
  332.       gc_objects_clear_marks(cp);
  333.  
  334.     end_phase("post-clear marks");
  335.  
  336.     for_chunks(min_collect - 1, mem, cp)
  337.       gc_clear_reloc(cp);
  338.  
  339.     end_phase("clear reloc");
  340.  
  341.     /* Set the relocation of roots outside any chunk to o_untraced, */
  342.     /* so we won't try to relocate pointers to them. */
  343.     /* (Currently, there aren't any.) */
  344.  
  345.     /* Disable freeing in the allocators of the spaces we are */
  346.     /* collecting, so finalization procedures won't cause problems. */
  347.     { int i;
  348.       for_collected_spaces(i)
  349.         gs_enable_free((gs_memory_t *)spaces.indexed[i], false);
  350.     }
  351.  
  352.     /* Compute relocation based on marks, in the spaces */
  353.     /* we are going to compact.  Also finalize freed objects. */
  354.  
  355.     for_collected_chunks(mem, cp)
  356.     {    gc_objects_set_reloc(cp);
  357.         gc_strings_set_reloc(cp);
  358.     }
  359.  
  360.     /* Re-enable freeing. */
  361.     { int i;
  362.       for_collected_spaces(i)
  363.         gs_enable_free((gs_memory_t *)spaces.indexed[i], true);
  364.     }
  365.  
  366.     end_phase("set reloc");
  367.  
  368.     /* Relocate pointers. */
  369.  
  370.     state.relocating_untraced = true;
  371.     for_chunks(min_collect - 1, mem, cp)
  372.       gc_do_reloc(cp, mem, &state);
  373.     state.relocating_untraced = false;
  374.     for_collected_chunks(mem, cp)
  375.       gc_do_reloc(cp, mem, &state);
  376.  
  377.     end_phase("relocate chunks");
  378.  
  379.     for_roots(max_trace, mem, rp)
  380.     {    if_debug3('6', "[6]relocating root 0x%lx: 0x%lx -> 0x%lx\n",
  381.               (ulong)rp, (ulong)rp->p, (ulong)*rp->p);
  382.         if ( rp->ptype == ptr_ref_type )
  383.         {    ref *pref = (ref *)*rp->p;
  384.             gs_reloc_refs((ref_packed *)pref,
  385.                       (ref_packed *)(pref + 1),
  386.                       &state);
  387.         }
  388.         else
  389.             *rp->p = (*rp->ptype->reloc)(*rp->p, &state);
  390.         if_debug3('6', "[6]relocated root 0x%lx: 0x%lx -> 0x%lx\n",
  391.               (ulong)rp, (ulong)rp->p, (ulong)*rp->p);
  392.     }
  393.  
  394.     end_phase("relocate roots");
  395.  
  396.     /* Compact data.  We only do this for spaces we are collecting. */
  397.  
  398.     for_collected_spaces(ispace)
  399.       { for_space_mems(ispace, mem)
  400.           { for_mem_chunks(mem, cp)
  401.           { if_debug_chunk('6', "[6]compacting chunk", cp);
  402.             gc_objects_compact(cp, &state);
  403.             gc_strings_compact(cp);
  404.             if_debug_chunk('6', "[6]after compaction:", cp);
  405.             if ( mem->pcc == cp )
  406.               mem->cc = *cp;
  407.           }
  408.         mem->saved = mem->reloc_saved;
  409.         ialloc_reset_free(mem);
  410.           }
  411.       }
  412.  
  413.     end_phase("compact");
  414.  
  415.     /* Free empty chunks. */
  416.  
  417.     for_collected_spaces(ispace)
  418.       for_space_mems(ispace, mem)
  419.         gc_free_empty_chunks(mem);
  420.  
  421.     end_phase("free empty chunks");
  422.  
  423.     /*
  424.      * Update previous_status to reflect any freed chunks,
  425.      * and set inherited to the negative of allocated,
  426.      * so it has no effect.  We must update previous_status by
  427.      * working back-to-front along the save chain, using pointer reversal.
  428.      * (We could update inherited in any order, since it only uses
  429.      * information local to the individual save level.)
  430.      */
  431.  
  432.     for_collected_spaces(ispace)
  433.       {    /* Reverse the pointers. */
  434.         alloc_save_t *curr;
  435.         alloc_save_t *prev = 0;
  436.         alloc_save_t *next;
  437.         gs_memory_status_t total;
  438.  
  439.         for ( curr = spaces.indexed[ispace]->saved; curr != 0;
  440.               prev = curr, curr = next
  441.             )
  442.           { next = curr->state.saved;
  443.             curr->state.saved = prev;
  444.           }
  445.         /* Now work the other way, accumulating the values. */
  446.         total.allocated = 0, total.used = 0;
  447.         for ( curr = prev, prev = 0; curr != 0;
  448.               prev = curr, curr = next
  449.             )
  450.           { mem = &curr->state;
  451.             next = mem->saved;
  452.             mem->saved = prev;
  453.             mem->previous_status = total;
  454.             if_debug3('6',
  455.                   "[6]0x%lx previous allocated=%lu, used=%lu\n",
  456.                   (ulong)mem, total.allocated, total.used);
  457.             gs_memory_status((gs_memory_t *)mem, &total);
  458.             mem->gc_allocated = mem->allocated + total.allocated;
  459.             mem->inherited = -mem->allocated;
  460.           }
  461.         mem = spaces.indexed[ispace];
  462.         mem->previous_status = total;
  463.         mem->gc_allocated = mem->allocated + total.allocated;
  464.         if_debug3('6', "[6]0x%lx previous allocated=%lu, used=%lu\n",
  465.               (ulong)mem, total.allocated, total.used);
  466.       }
  467.  
  468.     end_phase("update stats");
  469.  
  470. no_collect:
  471.  
  472.     /* Unregister the allocator roots. */
  473.  
  474.     for_spaces(ispace, max_trace)
  475.       gs_unregister_root((gs_memory_t *)spaces.indexed[ispace],
  476.                  &space_roots[ispace], "gc_top_level");
  477.  
  478.     end_phase("unregister space roots");
  479.  
  480. #ifdef DEBUG
  481.  
  482.     /* Validate the state.  This shouldn't be necessary.... */
  483.  
  484.     for_spaces(ispace, max_trace)
  485.       ialloc_validate_memory(spaces.indexed[ispace], &state);
  486.  
  487.     end_phase("validate pointers");
  488.  
  489. #endif
  490. }
  491.  
  492. /* ------ Debugging utilities ------ */
  493.  
  494. /* Validate a pointer to an object header. */
  495. #ifdef DEBUG
  496. #  define debug_check_object(pre, cp, gcst)\
  497.      ialloc_validate_object((pre) + 1, cp, gcst)
  498. #else
  499. #  define debug_check_object(pre, cp, gcst) DO_NOTHING
  500. #endif
  501.  
  502. /* ------ Unmarking phase ------ */
  503.  
  504. /* Unmark a single struct. */
  505. private void
  506. ptr_struct_unmark(void *vptr, gc_state_t *ignored)
  507. {    if ( vptr != 0 )
  508.       o_set_unmarked(((obj_header_t *)vptr - 1));
  509. }
  510.  
  511. /* Unmark a single string. */
  512. private void
  513. ptr_string_unmark(void *vptr, gc_state_t *gcst)
  514. {    discard(gc_string_mark(((gs_string *)vptr)->data,
  515.                    ((gs_string *)vptr)->size,
  516.                    false, gcst));
  517. }
  518.  
  519. /* Unmark the objects in a chunk. */
  520. private void
  521. gc_objects_clear_marks(chunk_t *cp)
  522. {    if_debug_chunk('6', "[6]unmarking chunk", cp);
  523.     SCAN_CHUNK_OBJECTS(cp)
  524.       DO_ALL
  525.         struct_proc_clear_marks((*proc)) =
  526.             pre->o_type->clear_marks;
  527. #ifdef DEBUG
  528.         if ( pre->o_type != &st_free )
  529.           debug_check_object(pre, cp, NULL);
  530. #endif
  531.         if_debug3('7', " [7](un)marking %s(%lu) 0x%lx\n",
  532.               struct_type_name_string(pre->o_type),
  533.               (ulong)size, (ulong)pre);
  534.         o_set_unmarked(pre);
  535.         if ( proc != 0 )
  536.             (*proc)(pre + 1, size);
  537.     END_OBJECTS_SCAN
  538. }
  539.  
  540. /* Mark 0- and 1-character names, and those referenced from the */
  541. /* op_array_nx_table, and unmark all the rest. */
  542. private void
  543. gc_unmark_names(void)
  544. {    register uint i;
  545.     name_unmark_all();
  546.     for ( i = 0; i < op_array_table_global.count; i++ )
  547.     {    uint nidx = op_array_table_global.nx_table[i];
  548.         name_index_ptr(nidx)->mark = 1;
  549.     }
  550.     for ( i = 0; i < op_array_table_local.count; i++ )
  551.     {    uint nidx = op_array_table_local.nx_table[i];
  552.         name_index_ptr(nidx)->mark = 1;
  553.     }
  554. }
  555.  
  556. /* ------ Marking phase ------ */
  557.  
  558. /* Initialize (a segment of) the mark stack. */
  559. private void
  560. gc_init_mark_stack(gc_mark_stack *pms, uint count)
  561. {    pms->next = 0;
  562.     pms->count = count;
  563.     pms->entries[0].ptr = 0;
  564.     pms->entries[0].index = 0;
  565.     pms->entries[0].is_refs = false;
  566. }
  567.  
  568. /* Mark starting from all marked objects in the interval of a chunk */
  569. /* needing rescanning. */
  570. private int
  571. gc_rescan_chunk(chunk_t *cp, gc_state_t *pstate, gc_mark_stack *pmstack)
  572. {    byte *sbot = cp->rescan_bot;
  573.     byte *stop = cp->rescan_top;
  574.     gs_gc_root_t root;
  575.     void *comp;
  576.     int more = 0;
  577.  
  578.     if ( sbot > stop )
  579.       return 0;
  580.     root.p = ∁
  581.     if_debug_chunk('6', "[6]rescanning chunk", cp);
  582.     cp->rescan_bot = cp->cend;
  583.     cp->rescan_top = cp->cbase;
  584.     SCAN_CHUNK_OBJECTS(cp)
  585.       DO_ALL
  586.         if ( (byte *)(pre + 1) + size < sbot )
  587.           ;
  588.         else if ( (byte *)(pre + 1) > stop )
  589.           return more;        /* 'break' won't work here */
  590.         else
  591.           {    if_debug2('7', " [7]scanning/marking 0x%lx(%lu)\n",
  592.               (ulong)pre, (ulong)size);
  593.         if ( pre->o_type == &st_refs )
  594.           {    ref_packed *rp = (ref_packed *)(pre + 1);
  595.             char *end = (char *)rp + size;
  596.             root.ptype = ptr_ref_type;
  597.             while ( (char *)rp < end )
  598.             {    comp = rp;
  599.                 if ( r_is_packed(rp) )
  600.                   { if ( r_has_pmark(rp) )
  601.                       { r_clear_pmark(rp);
  602.                     more |= gc_trace(&root, pstate,
  603.                              pmstack);
  604.                       }
  605.                     rp++;
  606.                   }
  607.                 else
  608.                   { if ( r_has_attr((ref *)rp, l_mark) )
  609.                       { r_clear_attrs((ref *)rp, l_mark);
  610.                     more |= gc_trace(&root, pstate,
  611.                              pmstack);
  612.                       }
  613.                     rp += packed_per_ref;
  614.                   }
  615.             }
  616.           }
  617.         else if ( !o_is_unmarked(pre) )
  618.           {    struct_proc_clear_marks((*proc)) =
  619.               pre->o_type->clear_marks;
  620.             root.ptype = ptr_struct_type;
  621.             comp = pre + 1;
  622.             if ( !o_is_untraced(pre) )
  623.               o_set_unmarked(pre);
  624.             if ( proc != 0 )
  625.               (*proc)(comp, size);
  626.             more |= gc_trace(&root, pstate, pmstack);
  627.           }
  628.       }
  629.     END_OBJECTS_SCAN
  630.     return more;
  631. }
  632.  
  633. /* Mark starting from all the objects in a chunk. */
  634. /* We assume that pstate->min_collect > avm_system, */
  635. /* so we don't have to trace names. */
  636. private int
  637. gc_trace_chunk(chunk_t *cp, gc_state_t *pstate, gc_mark_stack *pmstack)
  638. {    gs_gc_root_t root;
  639.     void *comp;
  640.     int more = 0;
  641.     int min_trace = pstate->min_collect;
  642.  
  643.     root.p = ∁
  644.     if_debug_chunk('6', "[6]marking from chunk", cp);
  645.     SCAN_CHUNK_OBJECTS(cp)
  646.       DO_ALL
  647.           {    if_debug2('7', " [7]scanning/marking 0x%lx(%lu)\n",
  648.               (ulong)pre, (ulong)size);
  649.         if ( pre->o_type == &st_refs )
  650.           {    ref_packed *rp = (ref_packed *)(pre + 1);
  651.             char *end = (char *)rp + size;
  652.  
  653.             root.ptype = ptr_ref_type;
  654.             while ( (char *)rp < end )
  655.             {    comp = rp;
  656.                 if ( r_is_packed(rp) )
  657.                   { /* No packed refs need tracing. */
  658.                     rp++;
  659.                   }
  660.                 else
  661.                   { if ( r_space((ref *)rp) >= min_trace )
  662.                       { r_clear_attrs((ref *)rp, l_mark);
  663.                         more |= gc_trace(&root, pstate,
  664.                              pmstack);
  665.                       }
  666.                     rp += packed_per_ref;
  667.                   }
  668.             }
  669.           }
  670.         else if ( !o_is_unmarked(pre) )
  671.           {    if ( !o_is_untraced(pre) )
  672.               o_set_unmarked(pre);
  673.             if ( pre->o_type != &st_free )
  674.               { struct_proc_clear_marks((*proc)) =
  675.                   pre->o_type->clear_marks;
  676.  
  677.                 root.ptype = ptr_struct_type;
  678.                 comp = pre + 1;
  679.                 if ( proc != 0 )
  680.                   (*proc)(comp, size);
  681.                 more |= gc_trace(&root, pstate, pmstack);
  682.               }
  683.           }
  684.       }
  685.     END_OBJECTS_SCAN
  686.     return more;
  687. }
  688.  
  689. /* Recursively mark from a (root) pointer. */
  690. /* Return -1 if we overflowed the mark stack, */
  691. /* 0 if we completed successfully without marking any new objects, */
  692. /* 1 if we completed and marked some new objects. */
  693. private int gc_extend_stack(P2(gc_mark_stack *, gc_state_t *));
  694. private int
  695. gc_trace(gs_gc_root_t *rp, gc_state_t *pstate, gc_mark_stack *pmstack)
  696. {    int min_trace = pstate->min_collect;
  697.     gc_mark_stack *pms = pmstack;
  698.     ms_entry *sp = pms->entries + 1;
  699.     /* We stop the mark stack 1 entry early, because we store into */
  700.     /* the entry beyond the top. */
  701.     ms_entry *stop = sp + pms->count - 2;
  702. #ifdef DEBUG
  703. #  define depth_dots depth_dots_proc(sp, pms)
  704. #endif
  705.     int new = 0;
  706.     void *nptr = *rp->p;
  707. #define mark_name(nidx, pname)\
  708.   { if ( !pname->mark )\
  709.      {  pname->mark = 1;\
  710.     new |= 1;\
  711.     if_debug2('8', "  [8]marked name 0x%lx(%u)\n", (ulong)pname, nidx);\
  712.      }\
  713.   }
  714.  
  715.     if ( nptr == 0 )
  716.       return 0;
  717.  
  718.     /* Initialize the stack */
  719.     sp->ptr = nptr;
  720.     if ( rp->ptype == ptr_ref_type )
  721.         sp->index = 1, sp->is_refs = true;
  722.     else
  723.     {    sp->index = 0, sp->is_refs = false;
  724.         if ( (*rp->ptype->mark)(nptr, pstate) )
  725.           new |= 1;
  726.     }
  727.     for ( ; ; )
  728.     {    gs_ptr_type_t ptp;
  729.         /*
  730.          * The following should really be an if..else, but that
  731.          * would force unnecessary is_refs tests.
  732.          */
  733.         if ( sp->is_refs )
  734.           goto do_refs;
  735.  
  736.     /* ---------------- Structure ---------------- */
  737.  
  738. do_struct:
  739.         {    obj_header_t *ptr = sp->ptr;
  740.             struct_proc_enum_ptrs((*mproc));
  741.  
  742.             if ( ptr == 0 )
  743.               { /* We've reached the bottom of a stack segment. */
  744.                 pms = pms->prev;
  745.                 if ( pms == 0 )
  746.                   break;        /* all done */
  747.                 stop = pms->entries + pms->count - 1;
  748.                 sp = stop;
  749.                 continue;
  750.               }
  751.             debug_check_object(ptr - 1, NULL, NULL);
  752. ts:            if_debug4('7', " [7]%smarking %s 0x%lx[%u]",
  753.                   depth_dots,
  754.                   struct_type_name_string(ptr[-1].o_type),
  755.                   (ulong)ptr, sp->index);
  756.             mproc = ptr[-1].o_type->enum_ptrs;
  757.             /* The cast in the following statement is the one */
  758.             /* place we need to break 'const' to make the */
  759.             /* template for pointer enumeration work. */
  760.             if ( mproc == 0 ||
  761.                  (ptp = (*mproc)
  762.                   (ptr, pre_obj_contents_size(ptr - 1),
  763.                    sp->index, (const void **)&nptr)) == 0
  764.                )
  765.             {    if_debug0('7', " - done\n");
  766.                 sp--;
  767.                 continue;
  768.             }
  769.             sp->index++;
  770.             if_debug1('7', " = 0x%lx\n", (ulong)nptr);
  771.             /* Descend into nptr, whose pointer type is ptp. */
  772.             if ( ptp == ptr_struct_type )
  773.               { sp[1].index = 0;
  774.                 sp[1].is_refs = false;
  775.                 if ( sp == stop )
  776.                   goto push;
  777.                 if ( !ptr_struct_mark(nptr, pstate) )
  778.                   goto ts;
  779.                 new |= 1;
  780.                 (++sp)->ptr = nptr;
  781.                 goto do_struct;
  782.               }
  783.             else if ( ptp == ptr_ref_type )
  784.               { sp[1].index = 1;
  785.                 sp[1].is_refs = true;
  786.                 if ( sp == stop )
  787.                   goto push;
  788.                 new |= 1;
  789.                 (++sp)->ptr = nptr;
  790.                 goto do_refs;
  791.               }
  792.             else
  793.               { /* We assume this is some non-pointer- */
  794.                 /* containing type. */
  795.                 if ( (*ptp->mark)(nptr, pstate) )
  796.                   new |= 1;
  797.                 goto ts;
  798.               }
  799.         }
  800.  
  801.     /* ---------------- Refs ---------------- */
  802.  
  803. do_refs:
  804.         {    ref_packed *pptr = sp->ptr;
  805.  
  806. tr:            if ( !sp->index )
  807.               { --sp;
  808.                 continue;
  809.               }
  810.             --(sp->index);
  811.             if_debug3('8', "  [8]%smarking refs 0x%lx[%u]\n",
  812.                   depth_dots, (ulong)pptr, sp->index);
  813. #define rptr ((ref *)pptr)
  814.             if ( r_is_packed(rptr) )
  815.             {    if ( !r_has_pmark(pptr) )
  816.                   { r_set_pmark(pptr);
  817.                     new |= 1;
  818.                     if ( r_packed_is_name(pptr) )
  819.                       { uint nidx = packed_name_index(pptr);
  820.                     name *pname = name_index_ptr(nidx);
  821.                     mark_name(nidx, pname);
  822.                       }
  823.                   }
  824.                 ++pptr;
  825.                 goto tr;
  826.             }
  827.             if ( r_has_attr(rptr, l_mark) )
  828.               { pptr = (ref_packed *)(rptr + 1);
  829.                 goto tr;
  830.               }
  831.             r_set_attrs(rptr, l_mark);
  832.             new |= 1;
  833.             if ( r_space(rptr) < min_trace )
  834.               { /* Note that this always picks up all scalars. */
  835.                 pptr = (ref_packed *)(rptr + 1);
  836.                 goto tr;
  837.               } 
  838.             sp->ptr = rptr + 1;
  839.             switch ( r_type(rptr) )
  840.                {
  841.             /* Struct cases */
  842.             case t_file:
  843.                 nptr = rptr->value.pfile;
  844. rs:                sp[1].is_refs = false;
  845.                 sp[1].index = 0;
  846.                 if ( sp == stop )
  847.                   { ptp = ptr_struct_type;
  848.                     break;
  849.                   }
  850.                 if ( !ptr_struct_mark(nptr, pstate) )
  851.                   goto nr;
  852.                 new |= 1;
  853.                 (++sp)->ptr = nptr;
  854.                 goto do_struct;
  855.             case t_device:
  856.                 nptr = rptr->value.pdevice;
  857.                 goto rs;
  858.             case t_fontID:
  859.             case t_struct:
  860.             case t_astruct:
  861.                 nptr = rptr->value.pstruct;
  862.                 goto rs;
  863.             /* Non-trivial non-struct cases */
  864.             case t_dictionary:
  865.                 nptr = rptr->value.pdict;
  866.                 sp[1].index = sizeof(dict) / sizeof(ref);
  867.                 goto rrp;
  868.             case t_array:
  869.                 nptr = rptr->value.refs;
  870. rr:                if ( (sp[1].index = r_size(rptr)) == 0 )
  871.                 {    /* Set the base pointer to 0, */
  872.                     /* so we never try to relocate it. */
  873.                     rptr->value.refs = 0;
  874.                     goto nr;
  875.                 }
  876. rrp:
  877. rrc:                sp[1].is_refs = true;
  878.                 if ( sp == stop )
  879.                   break;
  880.                 new |= 1;
  881.                 (++sp)->ptr = nptr;
  882.                 goto do_refs;
  883.             case t_mixedarray: case t_shortarray:
  884.                 nptr = (void *)rptr->value.packed; /* discard const */
  885.                 goto rr;
  886.             case t_name:
  887.                 mark_name(name_index(rptr), rptr->value.pname);
  888. nr:                pptr = (ref_packed *)(rptr + 1);
  889.                 goto tr;
  890.             case t_string:
  891.                 if ( gc_string_mark(rptr->value.bytes, r_size(rptr), true, pstate) )
  892.                   new |= 1;
  893.                 goto nr;
  894.             case t_oparray:
  895.                 nptr = (void *)rptr->value.const_refs;    /* discard const */
  896.                 sp[1].index = 1;
  897.                 goto rrc;
  898.             default:
  899.                 goto nr;
  900.                }
  901. #undef rptr
  902.         }
  903.  
  904.     /* ---------------- Recursion ---------------- */
  905.  
  906. push:
  907.         if ( sp == stop )
  908.           {    /* The current segment is full. */
  909.             int new_added = gc_extend_stack(pms, pstate);
  910.             if ( new_added )
  911.               { new |= new_added;
  912.                 continue;
  913.               }
  914.             pms = pms->next;
  915.             stop = pms->entries + pms->count - 1;
  916.             pms->entries[1] = sp[1];
  917.             sp = pms->entries;
  918.           }
  919.         /* index and is_refs are already set */
  920.         if ( !sp[1].is_refs )
  921.           { if ( !(*ptp->mark)(nptr, pstate) )
  922.               continue;
  923.             new |= 1;
  924.           }
  925.         (++sp)->ptr = nptr;
  926.     }
  927.     return new;
  928. }
  929. /* Link to, attempting to allocate if necessary, */
  930. /* another chunk of mark stack. */
  931. private int
  932. gc_extend_stack(gc_mark_stack *pms, gc_state_t *pstate)
  933. {    if ( pms->next == 0 )
  934.       { /* Try to allocate another segment. */
  935.         uint count;
  936.  
  937.         for ( count = ms_size_desired; count >= ms_size_min; count >>= 1 )
  938.           { pms->next =
  939.           gs_malloc(1, sizeof(gc_mark_stack) +
  940.                 sizeof(ms_entry) * count,
  941.                 "gc mark stack");
  942.         if ( pms->next != 0 )
  943.           break;
  944.           }
  945.         if ( pms->next == 0 )
  946.           { /* The mark stack overflowed. */
  947.         ms_entry *sp = pms->entries + pms->count - 1;
  948.         byte *cptr = sp->ptr;    /* container */
  949.         chunk_t *cp = gc_locate(cptr, pstate);
  950.         int new = 1;
  951.  
  952.         if ( cp == 0 )
  953.           { /* We were tracing outside collectible */
  954.             /* storage.  This can't happen. */
  955.             lprintf1("mark stack overflowed while outside collectible space at 0x%lx!\n",
  956.                  (ulong)cptr);
  957.             gs_abort();
  958.           }
  959.         if ( cptr < cp->rescan_bot )
  960.           cp->rescan_bot = cptr, new = -1;
  961.         if ( cptr > cp->rescan_top )
  962.           cp->rescan_top = cptr, new = -1;
  963.         return new;
  964.           }
  965.         gc_init_mark_stack(pms->next, count);
  966.         pms->next->prev = pms;
  967.         pms->next->on_heap = true;
  968.       }
  969.     return 0;
  970. }
  971.  
  972. /* Mark a struct.  Return true if new mark. */
  973. private bool
  974. ptr_struct_mark(void *vptr, gc_state_t *ignored)
  975. {    obj_header_t *ptr = vptr;
  976.     if ( vptr == 0 )
  977.         return false;
  978.     ptr--;            /* point to header */
  979.     if ( !o_is_unmarked(ptr) )
  980.         return false;
  981.     o_mark(ptr);
  982.     return true;
  983. }
  984.  
  985. /* Mark a string.  Return true if new mark. */
  986. private bool
  987. ptr_string_mark(void *vptr, gc_state_t *gcst)
  988. {    return gc_string_mark(((gs_string *)vptr)->data,
  989.                   ((gs_string *)vptr)->size,
  990.                   true, gcst);
  991. }
  992.  
  993. /* Finish tracing by marking names. */
  994. private bool
  995. gc_trace_finish(gc_state_t *pstate)
  996. {    uint nidx = 0;
  997.     bool marked = false;
  998.     while ( (nidx = name_next_valid_index(nidx)) != 0 )
  999.     {    name *pname = name_index_ptr(nidx);
  1000.         if ( pname->mark )
  1001.         {    if ( !pname->foreign_string && gc_string_mark(pname->string_bytes, pname->string_size, true, pstate) )
  1002.               marked = true;
  1003.             marked |= ptr_struct_mark(name_index_ptr_sub_table(nidx, pname), pstate);
  1004.         }
  1005.     }
  1006.     return marked;
  1007. }
  1008.  
  1009. /* ------ Relocation planning phase ------ */
  1010.  
  1011. /* Initialize the relocation information in the chunk header. */
  1012. private void
  1013. gc_init_reloc(chunk_t *cp)
  1014. {    chunk_head_t *chead = cp->chead;
  1015.     chead->dest = cp->cbase;
  1016.     chead->free.o_back =
  1017.       offset_of(chunk_head_t, free) >> obj_back_shift;
  1018.     chead->free.o_size = sizeof(obj_header_t);
  1019.     chead->free.o_nreloc = 0;
  1020. }
  1021.  
  1022. /* Set marks and clear relocation for chunks that won't be compacted. */
  1023. private void
  1024. gc_clear_reloc(chunk_t *cp)
  1025. {    byte *pfree = (byte *)&cp->chead->free;
  1026.  
  1027.     gc_init_reloc(cp);
  1028.     SCAN_CHUNK_OBJECTS(cp)
  1029.       DO_ALL
  1030.         const struct_shared_procs_t _ds *procs =
  1031.           pre->o_type->shared;
  1032.  
  1033.         if ( procs != 0 )
  1034.           (*procs->clear_reloc)(pre, size);
  1035.         o_set_untraced(pre);
  1036.         if ( !pre->o_large )
  1037.           pre->o_back = ((byte *)pre - pfree) >> obj_back_shift;
  1038.     END_OBJECTS_SCAN
  1039.     gc_strings_set_marks(cp, true);
  1040.     gc_strings_clear_reloc(cp);
  1041. }
  1042.  
  1043. /* Set the relocation for the objects in a chunk. */
  1044. /* This will never be called for a chunk with any o_untraced objects. */
  1045. private void
  1046. gc_objects_set_reloc(chunk_t *cp)
  1047. {    uint reloc = 0;
  1048.     chunk_head_t *chead = cp->chead;
  1049.     byte *pfree = (byte *)&chead->free;    /* most recent free object */
  1050.     if_debug_chunk('6', "[6]setting reloc for chunk", cp);
  1051.     gc_init_reloc(cp);
  1052.     SCAN_CHUNK_OBJECTS(cp)
  1053.       DO_ALL
  1054.         struct_proc_finalize((*finalize));
  1055.         const struct_shared_procs_t _ds *procs =
  1056.           pre->o_type->shared;
  1057.         if ( (procs == 0 ? o_is_unmarked(pre) :
  1058.               !(*procs->set_reloc)(pre, reloc, size))
  1059.            )
  1060.           {    /* Free object */
  1061.             reloc += sizeof(obj_header_t) + obj_align_round(size);
  1062.             if ( (finalize = pre->o_type->finalize) != 0 )
  1063.               {    if_debug2('u', "[u]GC finalizing %s 0x%lx\n",
  1064.                       struct_type_name_string(pre->o_type),
  1065.                       (ulong)(pre + 1));
  1066.                 (*finalize)(pre + 1);
  1067.               }
  1068.             if ( pre->o_large )
  1069.               {    /* We should chop this up into small */
  1070.                 /* free blocks, but there's no value */
  1071.                 /* in doing this right now. */
  1072.                 o_set_unmarked_large(pre);
  1073.               }
  1074.             else
  1075.               {    pfree = (byte *)pre;
  1076.                 pre->o_back =
  1077.                   (pfree - (byte *)chead) >> obj_back_shift;
  1078.                 pre->o_nreloc = reloc;
  1079.               }
  1080.             if_debug3('7', " [7]at 0x%lx, unmarked %lu, new reloc = %u\n",
  1081.                   (ulong)pre, (ulong)size, reloc);
  1082.           }
  1083.         else
  1084.           {    /* Useful object */
  1085.             debug_check_object(pre, cp, NULL);
  1086.             if ( pre->o_large )
  1087.               {    if ( o_is_unmarked_large(pre) )
  1088.                   o_mark_large(pre);
  1089.               }
  1090.             else
  1091.               pre->o_back =
  1092.                 ((byte *)pre - pfree) >> obj_back_shift;
  1093.           }
  1094.     END_OBJECTS_SCAN
  1095. #ifdef DEBUG
  1096.     if ( reloc != 0 )
  1097.     { if_debug1('6', "[6]freed %u", reloc);
  1098.       if_debug_chunk('6', " in", cp);
  1099.     }
  1100. #endif
  1101. }
  1102.  
  1103. /* ------ Relocation phase ------ */
  1104.  
  1105. /* Relocate the pointers in all the objects in a chunk. */
  1106. private void
  1107. gc_do_reloc(chunk_t *cp, gs_ref_memory_t *mem, gc_state_t *pstate)
  1108. {    chunk_head_t *chead = cp->chead;
  1109.     if_debug_chunk('6', "[6]relocating in chunk", cp);
  1110.     SCAN_CHUNK_OBJECTS(cp)
  1111.       DO_ALL
  1112.         /* We need to relocate the pointers in an object iff */
  1113.         /* it is o_untraced, or it is a useful object. */
  1114.         /* An object is free iff its back pointer points to */
  1115.         /* the chunk_head structure. */
  1116.         if ( o_is_untraced(pre) ||
  1117.              (pre->o_large ? !o_is_unmarked(pre) :
  1118.               pre->o_back << obj_back_shift !=
  1119.                 (byte *)pre - (byte *)chead)
  1120.            )
  1121.           {    struct_proc_reloc_ptrs((*proc)) =
  1122.                 pre->o_type->reloc_ptrs;
  1123.             if_debug3('7',
  1124.                   " [7]relocating ptrs in %s(%lu) 0x%lx\n",
  1125.                   struct_type_name_string(pre->o_type),
  1126.                   (ulong)size, (ulong)pre);
  1127.             if ( proc != 0 )
  1128.                 (*proc)(pre + 1, size, pstate);
  1129.           }
  1130.     END_OBJECTS_SCAN
  1131. }
  1132.  
  1133. /* Print pointer relocation if debugging. */
  1134. /* We have to provide this procedure even if DEBUG is not defined, */
  1135. /* in case one of the other GC modules was compiled with DEBUG. */
  1136. void *
  1137. print_reloc_proc(const void *obj, const char *cname, void *robj)
  1138. {    if_debug3('9', "  [9]relocate %s * 0x%lx to 0x%lx\n",
  1139.           cname, (ulong)obj, (ulong)robj);
  1140.     return robj;
  1141. }
  1142.  
  1143. /* Relocate a pointer to an (aligned) object. */
  1144. /* See gsmemory.h for why the argument is const and the result is not. */
  1145. void /*obj_header_t*/ *
  1146. gs_reloc_struct_ptr(const void /*obj_header_t*/ *obj, gc_state_t *gcst)
  1147. {    const void *robj;
  1148.  
  1149.     if ( obj == 0 )
  1150.       return print_reloc(obj, "NULL", 0);
  1151. #define optr ((const obj_header_t *)obj)
  1152.     debug_check_object(optr - 1, NULL, gcst);
  1153.     /* The following should be a conditional expression, */
  1154.     /* but Sun's cc compiler can't handle it. */
  1155.     if ( optr[-1].o_large )
  1156.       robj = obj;
  1157.     else
  1158.       {    uint back = optr[-1].o_back;
  1159.         if ( back == o_untraced )
  1160.           robj = obj;
  1161.         else
  1162.           {
  1163. #ifdef DEBUG
  1164.             /* Do some sanity checking. */
  1165.             if ( back > gcst->space_local->chunk_size >> obj_back_shift )
  1166.               {    lprintf2("Invalid back pointer %u at 0x%lx!\n",
  1167.                      back, (ulong)obj);
  1168.                 gs_abort();
  1169.               }
  1170. #endif
  1171.             {    const obj_header_t *pfree = (const obj_header_t *)
  1172.               ((const char *)(optr - 1) -
  1173.                 (back << obj_back_shift));
  1174.             const chunk_head_t *chead = (const chunk_head_t *)
  1175.               ((const char *)pfree -
  1176.                 (pfree->o_back << obj_back_shift));
  1177.             robj = chead->dest +
  1178.               ((const char *)obj - (const char *)(chead + 1) -
  1179.                 pfree->o_nreloc);
  1180.             }
  1181.           }
  1182.       }
  1183.     return print_reloc(obj,
  1184.                struct_type_name_string(optr[-1].o_type),
  1185.                (void *)robj);    /* discard const */
  1186. #undef optr
  1187. }
  1188.  
  1189. /* ------ Compaction phase ------ */
  1190.  
  1191. /* Compact the objects in a chunk. */
  1192. /* This will never be called for a chunk with any o_untraced objects. */
  1193. private void
  1194. gc_objects_compact(chunk_t *cp, gc_state_t *gcst)
  1195. {    chunk_head_t *chead = cp->chead;
  1196.     obj_header_t *dpre = (obj_header_t *)chead->dest;
  1197.     SCAN_CHUNK_OBJECTS(cp)
  1198.       DO_ALL
  1199.         /* An object is free iff its back pointer points to */
  1200.         /* the chunk_head structure. */
  1201.         if ( (pre->o_large ? !o_is_unmarked(pre) :
  1202.               pre->o_back << obj_back_shift !=
  1203.                 (byte *)pre - (byte *)chead)
  1204.            )
  1205.           {    const struct_shared_procs_t _ds *procs =
  1206.               pre->o_type->shared;
  1207.             debug_check_object(pre, cp, gcst);
  1208.             if_debug4('7',
  1209.                   " [7]compacting %s 0x%lx(%lu) to 0x%lx\n",
  1210.                   struct_type_name_string(pre->o_type),
  1211.                   (ulong)pre, (ulong)size, (ulong)dpre);
  1212.             if ( procs == 0 )
  1213.               { if ( dpre != pre )
  1214.                   memmove(dpre, pre,
  1215.                       sizeof(obj_header_t) + size);
  1216.               }
  1217.             else
  1218.               (*procs->compact)(pre, dpre, size);
  1219.             dpre = (obj_header_t *)
  1220.               ((byte *)dpre + obj_size_round(size));
  1221.           }
  1222.     END_OBJECTS_SCAN
  1223.     if ( cp->outer == 0 && chead->dest != cp->cbase )
  1224.       dpre = (obj_header_t *)cp->cbase; /* compacted this chunk into another */
  1225.     gs_alloc_fill(dpre, gs_alloc_fill_collected, cp->cbot - (byte *)dpre);
  1226.     cp->cbot = (byte *)dpre;
  1227.     cp->rcur = 0;
  1228.     cp->rtop = 0;        /* just to be sure */
  1229. }
  1230.  
  1231. /* ------ Cleanup ------ */
  1232.  
  1233. /* Free empty chunks. */
  1234. private void
  1235. gc_free_empty_chunks(gs_ref_memory_t *mem)
  1236. {    chunk_t *cp;
  1237.     chunk_t *csucc;
  1238.     /* Free the chunks in reverse order, */
  1239.     /* to encourage LIFO behavior. */
  1240.     for ( cp = mem->clast; cp != 0; cp = csucc )
  1241.     {    /* Make sure this isn't an inner chunk, */
  1242.         /* or a chunk that has inner chunks. */
  1243.         csucc = cp->cprev;     /* save before freeing */
  1244.         if ( cp->cbot == cp->cbase && cp->ctop == cp->climit &&
  1245.              cp->outer == 0 && cp->inner_count == 0
  1246.            )
  1247.           {    alloc_free_chunk(cp, mem);
  1248.             if ( mem->pcc == cp )
  1249.               mem->pcc = 0;
  1250.           }
  1251.     }
  1252. }
  1253.